Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos and improve documentation #16422

Open
wants to merge 445 commits into
base: compatible
Choose a base branch
from

Conversation

Dimitrolito
Copy link

This pull request fixes several typographical errors and improves the documentation in the following files:

  • README.md
  • 0016-transition-frontier-persistence.md
  • 0020-transition-frontier-extensions-2.md

Changes:

  • Fixed the use of "a" vs. "an" in README.md.
  • Added missing hyphens in compound adjectives like "non-optimal" and "user-friendly".
  • Corrected grammatical errors in the explanation of the transition frontier persistence and extension processes.
  • Enhanced readability and consistency in the documentation.

Testing:

  • No changes to functionality were made, so no new tests are required. CI will verify that all existing tests pass.

Checklist:

  • Dependency versions are unchanged
  • Modified the current draft of release notes with details on what is completed or incomplete within this project
  • Documented code purpose and usage
  • All tests pass (CI will check this if you didn't)
  • Closes issues: None

dkijania and others added 30 commits September 18, 2024 10:15
…debian_name_logic

Fix debian branch name logic dev
This reverts commit 091ddca79ae8e939d4065d9f195bd075898704e5, reversing
changes made to b5d2546.
…ve_HEAD_once_for_all

pass BRANCH_NAME to export-git-env-vars script properly
…ve_extract_dump_archive_test_dev

Port patch archive test to dev
…-develop-2024-09-19

Merge back to develop
…_removing_leaderboard_dev

[DEV] Remove Leaderboard project
dkijania and others added 24 commits November 25, 2024 21:02
…ement_test_ledger_apply_dev

implement test ledger apply dev
…ania/sign_apt_debians_dev

[dev] add optional debians sign
fix cleanup method name
fix rosetta-connectivity.sh name
increase timeout for rosetta connectivity test
add connectivity tests
export postgres variables in docker-start.sh
use single-run option for missing-block-guardian
us mina missing block guardian script
…tta_start_issue_dev

port rosetta docker-start fix and test to dev
…_rosetta_start_issue_again

[dev] Run rosetta connectivity in stable pipelines
@Dimitrolito Dimitrolito requested a review from a team as a code owner December 15, 2024 13:27
@dannywillems
Copy link
Member

Can you do it on compatible instead, please?

@Dimitrolito Dimitrolito changed the base branch from develop to compatible December 16, 2024 13:12
@Dimitrolito Dimitrolito requested review from a team as code owners December 16, 2024 13:12
@Dimitrolito
Copy link
Author

@dannywillems

Sure, I've moved it to the compatible branch instead

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants